Mercurial > hg > orthanc

comparison Plugins/Samples/Common/OrthancPluginException.h @ 2234:a78d15509a1c

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