Mercurial > hg > orthanc

comparison OrthancServer/Plugins/Samples/Common/OrthancPluginException.h @ 4044:d25f4c0fa160 framework

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
splitting code into OrthancFramework and OrthancServer
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 10 Jun 2020 20:30:34 +0200
parents Plugins/Samples/Common/OrthancPluginException.h@78ee0155ec67
children 4bb7522a63e0
comparison
equal deleted inserted replaced
4043:6c6239aec462 4044:d25f4c0fa160
1 /**
2 * Orthanc - A Lightweight, RESTful DICOM Store
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
4 * Department, University Hospital of Liege, Belgium
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
6 *
7 * This program is free software: you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
11 *
12 * In addition, as a special exception, the copyright holders of this
13 * program give permission to link the code of its release with the
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
15 * that use the same license as the "OpenSSL" library), and distribute
16 * the linked executables. You must obey the GNU General Public License
17 * in all respects for all of the code used other than "OpenSSL". If you
18 * modify file(s) with this exception, you may extend this exception to
19 * your version of the file(s), but you are not obligated to do so. If
20 * you do not wish to do so, delete this exception statement from your
21 * version. If you delete this exception statement from all source files
22 * in the program, then also delete it here.
23 *
24 * This program is distributed in the hope that it will be useful, but
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27 * General Public License for more details.
28 *
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
31 **/
32
33
34 #pragma once
35
36 #if !defined(HAS_ORTHANC_EXCEPTION)
37 # error The macro HAS_ORTHANC_EXCEPTION must be defined
38 #endif
39
40
41 #if HAS_ORTHANC_EXCEPTION == 1
42 # include <OrthancException.h>
43 # define ORTHANC_PLUGINS_ERROR_ENUMERATION ::Orthanc::ErrorCode
44 # define ORTHANC_PLUGINS_EXCEPTION_CLASS ::Orthanc::OrthancException
45 # define ORTHANC_PLUGINS_GET_ERROR_CODE(code) ::Orthanc::ErrorCode_ ## code
46 #else
47 # include <orthanc/OrthancCPlugin.h>
48 # define ORTHANC_PLUGINS_ERROR_ENUMERATION ::OrthancPluginErrorCode
49 # define ORTHANC_PLUGINS_EXCEPTION_CLASS ::OrthancPlugins::PluginException
50 # define ORTHANC_PLUGINS_GET_ERROR_CODE(code) ::OrthancPluginErrorCode_ ## code
51 #endif
52
53
54 #define ORTHANC_PLUGINS_THROW_PLUGIN_ERROR_CODE(code) \
55 throw ORTHANC_PLUGINS_EXCEPTION_CLASS(static_cast<ORTHANC_PLUGINS_ERROR_ENUMERATION>(code));
56
57
58 #define ORTHANC_PLUGINS_THROW_EXCEPTION(code) \
59 throw ORTHANC_PLUGINS_EXCEPTION_CLASS(ORTHANC_PLUGINS_GET_ERROR_CODE(code));
60
61
62 #define ORTHANC_PLUGINS_CHECK_ERROR(code) \
63 if (code != ORTHANC_PLUGINS_GET_ERROR_CODE(Success)) \
64 { \
65 ORTHANC_PLUGINS_THROW_EXCEPTION(code); \
66 }
67
68
69 namespace OrthancPlugins
70 {
71 #if HAS_ORTHANC_EXCEPTION == 0
72 class PluginException
73 {
74 private:
75 OrthancPluginErrorCode code_;
76
77 public:
78 explicit PluginException(OrthancPluginErrorCode code) : code_(code)
79 {
80 }
81
82 OrthancPluginErrorCode GetErrorCode() const
83 {
84 return code_;
85 }
86
87 const char* What(OrthancPluginContext* context) const
88 {
89 const char* description = OrthancPluginGetErrorDescription(context, code_);
90 if (description)
91 {
92 return description;
93 }
94 else
95 {
96 return "No description available";
97 }
98 }
99 };
100 #endif
101 }