Mercurial > hg > orthanc

annotate OrthancFramework/Sources/Logging.h @ 4845:02d77189d8ba received-instance-callback

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
added ReceivedInstanceCallback + sample C++ plugin
author Alain Mazy <am@osimis.io>
date Thu, 09 Dec 2021 17:22:40 +0100
parents 7053502fbf97
children 43e613a7756b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1551
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4313
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
4831
7053502fbf97 added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4790
diff changeset
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
11 * the License, or (at your option) any later version.
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * This program is distributed in the hope that it will be useful, but
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
16 * Lesser General Public License for more details.
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
20 * <http://www.gnu.org/licenses/>.
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 **/
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
22
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
23
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 #pragma once
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
26 // To have ORTHANC_ENABLE_LOGGING defined if using the shared library
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
27 #include "OrthancFramework.h"
4313
91554aecff9a removed a friend method for better abi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
28 #include "Compatibility.h"
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
29
1551
0dba274074eb standalone logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1507
diff changeset
30 #include <iostream>
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
31
2137
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2134
diff changeset
32 #if !defined(ORTHANC_ENABLE_LOGGING)
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2134
diff changeset
33 # error The macro ORTHANC_ENABLE_LOGGING must be defined
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2134
diff changeset
34 #endif
595cf22b3e7e safety checks of macros
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2134
diff changeset
35
2483
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
36 #if !defined(ORTHANC_ENABLE_LOGGING_STDIO)
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
37 # if ORTHANC_ENABLE_LOGGING == 1
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
38 # error The macro ORTHANC_ENABLE_LOGGING_STDIO must be defined
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
39 # else
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
40 # define ORTHANC_ENABLE_LOGGING_STDIO 0
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
41 # endif
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
42 #endif
9c54c40eaf25 logging primitives for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
43
2504
78862372ea88 fix msvc build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2484
diff changeset
44
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 namespace Orthanc
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
46 {
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 namespace Logging
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 {
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
49 enum LogLevel
3996
c2b9a7a1c74a ORTHANC_FRAMEWORK_BUILDING_PLUGIN
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3995
diff changeset
50 {
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
51 LogLevel_ERROR,
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
52 LogLevel_WARNING,
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
53 LogLevel_INFO,
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
54 LogLevel_TRACE
3996
c2b9a7a1c74a ORTHANC_FRAMEWORK_BUILDING_PLUGIN
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3995
diff changeset
55 };
4268
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
56
4270
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
57 /**
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
58 * NB: The log level for each category is encoded as a bit
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
59 * mask. As a consequence, there can be up to 31 log categories
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
60 * (not 32, as the value GENERIC is reserved for the log commands
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
61 * that don't fall in a specific category).
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
62 **/
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
63 enum LogCategory
4268
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
64 {
4270
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
65 LogCategory_GENERIC = (1 << 0),
4271
1bd14c900699 LogCategory_PLUGINS
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4270
diff changeset
66 LogCategory_PLUGINS = (1 << 1),
4294
0923247e69f6 log categories: rest -> http + added lua & jobs
Alain Mazy <alain@mazy.be>
parents: 4275
diff changeset
67 LogCategory_HTTP = (1 << 2),
4272
1661544ea94d LogCategory_REST
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4271
diff changeset
68 LogCategory_SQLITE = (1 << 3),
4294
0923247e69f6 log categories: rest -> http + added lua & jobs
Alain Mazy <alain@mazy.be>
parents: 4275
diff changeset
69 LogCategory_DICOM = (1 << 4),
0923247e69f6 log categories: rest -> http + added lua & jobs
Alain Mazy <alain@mazy.be>
parents: 4275
diff changeset
70 LogCategory_JOBS = (1 << 5),
4790
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
71 LogCategory_LUA = (1 << 6)
4268
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
72 };
3996
c2b9a7a1c74a ORTHANC_FRAMEWORK_BUILDING_PLUGIN
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3995
diff changeset
73
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
74 ORTHANC_PUBLIC const char* EnumerationToString(LogLevel level);
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
75
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
76 ORTHANC_PUBLIC LogLevel StringToLogLevel(const char* level);
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
77
3995
1f405a3fdeca reorganizing Logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3993
diff changeset
78 // "pluginContext" must be of type "OrthancPluginContext"
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
79 ORTHANC_PUBLIC void InitializePluginContext(void* pluginContext);
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
80
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
81 ORTHANC_PUBLIC void Initialize();
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
83 ORTHANC_PUBLIC void Finalize();
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
85 ORTHANC_PUBLIC void Reset();
2015
bcc575732aef New option "--logfile" to output the Orthanc log to the given file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2014
diff changeset
86
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
87 ORTHANC_PUBLIC void Flush();
2015
bcc575732aef New option "--logfile" to output the Orthanc log to the given file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2014
diff changeset
88
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
89 ORTHANC_PUBLIC void EnableInfoLevel(bool enabled);
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
90
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
91 ORTHANC_PUBLIC void EnableTraceLevel(bool enabled);
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
92
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
93 ORTHANC_PUBLIC bool IsTraceLevelEnabled();
3359
815b81142ff7 Enable custom logging functions to redirect to emscripten specific logging calls
Benjamin Golinvaux <bgo@osimis.io>
parents: 3353
diff changeset
94
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
95 ORTHANC_PUBLIC bool IsInfoLevelEnabled();
3353
54cdad5a7228 Added a public function that will use emscripten-specific logging functions when using its SDK + scaffolding work. Build and UT OK on msvc15 x64. Not actually tested under *nix or emscripten yet
Benjamin Golinvaux <bgo@osimis.io>
parents: 3060
diff changeset
96
4270
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
97 ORTHANC_PUBLIC void SetCategoryEnabled(LogLevel level,
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
98 LogCategory category,
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
99 bool enabled);
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
100
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
101 ORTHANC_PUBLIC bool IsCategoryEnabled(LogLevel level,
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
102 LogCategory category);
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
103
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
104 ORTHANC_PUBLIC bool LookupCategory(LogCategory& target,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
105 const std::string& category);
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
106
4275
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4273
diff changeset
107 ORTHANC_PUBLIC unsigned int GetCategoriesCount();
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
108
4275
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4273
diff changeset
109 ORTHANC_PUBLIC const char* GetCategoryName(unsigned int i);
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4273
diff changeset
110
d7a50b7b8466 Dynamically access and/or change the verbosity of logging categories with the REST API
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4273
diff changeset
111 ORTHANC_PUBLIC const char* GetCategoryName(LogCategory category);
4270
251a8b07fa37 logging categories
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4269
diff changeset
112
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
113 ORTHANC_PUBLIC void SetTargetFile(const std::string& path);
2015
bcc575732aef New option "--logfile" to output the Orthanc log to the given file
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2014
diff changeset
114
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
115 ORTHANC_PUBLIC void SetTargetFolder(const std::string& path);
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
116
4313
91554aecff9a removed a friend method for better abi
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4294
diff changeset
117 struct ORTHANC_LOCAL NullStream : public std::ostream
1495
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
118 {
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
119 NullStream() :
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
120 std::ios(0),
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
121 std::ostream(0)
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
122 {
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
123 }
1551
0dba274074eb standalone logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1507
diff changeset
124
2504
78862372ea88 fix msvc build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2484
diff changeset
125 template <typename T>
78862372ea88 fix msvc build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2484
diff changeset
126 std::ostream& operator<< (const T& message)
2073
1d7a640c1dda fix build issues with Visual Studio 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2015
diff changeset
127 {
1d7a640c1dda fix build issues with Visual Studio 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2015
diff changeset
128 return *this;
1d7a640c1dda fix build issues with Visual Studio 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2015
diff changeset
129 }
1495
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
130 };
1551
0dba274074eb standalone logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1507
diff changeset
131 }
0dba274074eb standalone logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1507
diff changeset
132 }
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
133
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
134
4268
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
135
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
136 /**
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
137 * NB:
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
138 * - The "VLOG(unused)" macro is for backward compatibility with
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
139 * Orthanc <= 1.8.0.
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
140 * - The "CLOG()" macro stands for "category log" (new in Orthanc 1.8.1)
4268
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
141 **/
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
142
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
143 #if defined(LOG)
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
144 # error The macro LOG cannot be defined beforehand
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
145 #endif
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
146
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
147 #if defined(VLOG)
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
148 # error The macro VLOG cannot be defined beforehand
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
149 #endif
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
150
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
151 #if defined(CLOG)
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
152 # error The macro CLOG cannot be defined beforehand
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
153 #endif
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
154
1551
0dba274074eb standalone logging
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1507
diff changeset
155 #if ORTHANC_ENABLE_LOGGING != 1
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
156 # define LOG(level) ::Orthanc::Logging::NullStream()
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
157 # define VLOG(unused) ::Orthanc::Logging::NullStream()
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
158 # define CLOG(level, category) ::Orthanc::Logging::NullStream()
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
159 #else /* ORTHANC_ENABLE_LOGGING == 1 */
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
160 # define LOG(level) ::Orthanc::Logging::InternalLogger \
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
161 (::Orthanc::Logging::LogLevel_ ## level, \
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
162 ::Orthanc::Logging::LogCategory_GENERIC, __FILE__, __LINE__)
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
163 # define VLOG(unused) ::Orthanc::Logging::InternalLogger \
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
164 (::Orthanc::Logging::LogLevel_TRACE, \
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
165 ::Orthanc::Logging::LogCategory_GENERIC, __FILE__, __LINE__)
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
166 # define CLOG(level, category) ::Orthanc::Logging::InternalLogger \
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
167 (::Orthanc::Logging::LogLevel_ ## level, \
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
168 ::Orthanc::Logging::LogCategory_ ## category, __FILE__, __LINE__)
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
169 #endif
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
170
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
171
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
172
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
173 #if (ORTHANC_ENABLE_LOGGING == 1 && \
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
174 ORTHANC_ENABLE_LOGGING_STDIO == 1)
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
175 // This is notably for WebAssembly
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
176
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
177 #include <boost/lexical_cast.hpp>
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
178 #include <boost/noncopyable.hpp>
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
179 #include <sstream>
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
180
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
181 namespace Orthanc
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
182 {
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
183 namespace Logging
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
184 {
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
185 class ORTHANC_PUBLIC InternalLogger : public boost::noncopyable
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
186 {
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
187 private:
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
188 LogLevel level_;
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
189 LogCategory category_;
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
190 std::stringstream messageStream_;
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
191
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
192 public:
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
193 InternalLogger(LogLevel level,
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
194 LogCategory category,
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
195 const char* file /* ignored */,
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
196 int line /* ignored */) :
4268
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
197 level_(level),
0ae2ca210077 new macro TLOG() to replace VLOG() for trace logs with a category
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
198 category_(category)
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
199 {
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
200 }
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
201
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
202 // For backward binary compatibility with Orthanc Framework <= 1.8.0
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
203 InternalLogger(LogLevel level,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
204 const char* file /* ignored */,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
205 int line /* ignored */) :
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
206 level_(level),
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
207 category_(LogCategory_GENERIC)
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
208 {
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
209 }
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
210
4017
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
211 ~InternalLogger();
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
212
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
213 template <typename T>
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
214 std::ostream& operator<< (const T& message)
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
215 {
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
216 return messageStream_ << boost::lexical_cast<std::string>(message);
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
217 }
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
218 };
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
219 }
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
220 }
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
221
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
222 #endif
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
223
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
224
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
225
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
226 #if (ORTHANC_ENABLE_LOGGING == 1 && \
c783f4f29390 log using emscripten
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4014
diff changeset
227 ORTHANC_ENABLE_LOGGING_STDIO == 0)
2243
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
228
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
229 #include <boost/lexical_cast.hpp>
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
230 #include <boost/noncopyable.hpp>
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
231 #include <boost/thread/mutex.hpp>
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
232 #include <sstream>
2243
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
233
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
234 namespace Orthanc
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
235 {
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
236 namespace Logging
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
237 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
238 class ORTHANC_PUBLIC InternalLogger : public boost::noncopyable
2243
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
239 {
2dbfdafc2512 Logger compatible with the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2137
diff changeset
240 private:
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
241 boost::mutex::scoped_lock lock_;
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
242 LogLevel level_;
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
243 std::unique_ptr<std::stringstream> pluginStream_;
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
244 std::ostream* stream_;
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
245
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
246 void Setup(LogCategory category,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
247 const char* file,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
248 int line);
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
249
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
250 public:
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
251 InternalLogger(LogLevel level,
4269
c7bd2f21ccc3 new macro CLOG, and sharing more code between logging engines
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4268
diff changeset
252 LogCategory category,
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
253 const char* file,
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
254 int line);
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
255
4273
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
256 // For backward binary compatibility with Orthanc Framework <= 1.8.0
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
257 InternalLogger(LogLevel level,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
258 const char* file,
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
259 int line);
0034f855c023 tuning log categories from command-line, and binary compat with orthanc framework 1.7.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4272
diff changeset
260
1507
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1495
diff changeset
261 ~InternalLogger();
1495
fbe40117eb21 improve the performance of the internal logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1491
diff changeset
262
2504
78862372ea88 fix msvc build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2484
diff changeset
263 template <typename T>
3993
7e8bfda62b43 fix msvc builds
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
264 std::ostream& operator<< (const T& message)
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
265 {
2504
78862372ea88 fix msvc build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2484
diff changeset
266 return (*stream_) << boost::lexical_cast<std::string>(message);
2134
ddc75c6c712d Avoid hard crash if not enough memory
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2073
diff changeset
267 }
1489
1389834e130f basic logger
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1488
diff changeset
268 };
3353
54cdad5a7228 Added a public function that will use emscripten-specific logging functions when using its SDK + scaffolding work. Build and UT OK on msvc15 x64. Not actually tested under *nix or emscripten yet
Benjamin Golinvaux <bgo@osimis.io>
parents: 3060
diff changeset
269
54cdad5a7228 Added a public function that will use emscripten-specific logging functions when using its SDK + scaffolding work. Build and UT OK on msvc15 x64. Not actually tested under *nix or emscripten yet
Benjamin Golinvaux <bgo@osimis.io>
parents: 3060
diff changeset
270 /**
4004
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
271 * Set custom logging streams for the error, warning and info
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
272 * logs. This function may not be called if a log file or folder
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
273 * has been set beforehand. All three references must be valid.
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
274 *
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
275 * Please ensure the supplied streams remain alive and valid as
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
276 * long as logging calls are performed. In order to prevent
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
277 * dangling pointer usage, it is mandatory to call
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
278 * Orthanc::Logging::Reset() before the stream objects are
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
279 * destroyed and the references become invalid.
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
280 *
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
281 * This function must only be used by unit tests. It is ignored if
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4010
diff changeset
282 * InitializePluginContext() was called.
4004
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
283 **/
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
284 ORTHANC_PUBLIC void SetErrorWarnInfoLoggingStreams(std::ostream& errorStream,
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
285 std::ostream& warningStream,
9b5ace33a00d cleaning SetErrorWarnInfoLoggingStreams()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4003
diff changeset
286 std::ostream& infoStream);
1485
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
287 }
27661b33f624 Creation of Logging.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
288 }
1488
c8763b603b0e flag for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1487
diff changeset
289
3998
b3f09bc9734b sharing more code between the loggers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3996
diff changeset
290 #endif