annotate OrthancFramework/Sources/SharedLibrary.h @ 4304:50b0c69b653a

continued abi
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 06 Nov 2020 16:33:52 +0100
parents b30a8de92ad9
children d9473bd5ed43
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1632
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 893
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * 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
8 * 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
9 * 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
10 * the License, or (at your option) any later version.
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * 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
15 * Lesser General Public License for more details.
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
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
17 * 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
18 * 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
19 * <http://www.gnu.org/licenses/>.
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
25 #include "OrthancFramework.h"
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
26
2463
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
27 #if !defined(ORTHANC_SANDBOXED)
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
28 # error The macro ORTHANC_SANDBOXED must be defined
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
29 #endif
1632
eb8fbcf008b5 fix build with plugins disabled
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1630
diff changeset
30
2463
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
31 #if ORTHANC_SANDBOXED == 1
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
32 # error The namespace SystemToolbox cannot be used in sandboxed environments
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
33 #endif
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
1397
704de8c30ff5 modularization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
35 #if defined(_WIN32)
704de8c30ff5 modularization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
36 #include <windows.h>
704de8c30ff5 modularization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
37 #endif
704de8c30ff5 modularization
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
38
2463
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
39 #include <string>
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
40 #include <boost/noncopyable.hpp>
be5c0f4155f6 move SharedLibrary into OrthancFramework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
41
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 namespace Orthanc
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43 {
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
44 class ORTHANC_PUBLIC SharedLibrary : public boost::noncopyable
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45 {
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
46 public:
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
47 #if defined(_WIN32)
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
48 typedef FARPROC FunctionPointer;
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
49 #else
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
50 typedef void* FunctionPointer;
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
51 #endif
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
52
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53 private:
887
4066e6f2d134 PluginsManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 885
diff changeset
54 std::string path_;
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 void *handle_;
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
57 FunctionPointer GetFunctionInternal(const std::string& name);
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 884
diff changeset
58
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 public:
2223
29689b30f9ae cppcheck
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2136
diff changeset
60 explicit SharedLibrary(const std::string& path);
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 884
diff changeset
61
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 884
diff changeset
62 ~SharedLibrary();
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 884
diff changeset
63
4300
b30a8de92ad9 abi continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4119
diff changeset
64 const std::string& GetPath() const;
887
4066e6f2d134 PluginsManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 885
diff changeset
65
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 884
diff changeset
66 bool HasFunction(const std::string& name);
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 884
diff changeset
67
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 887
diff changeset
68 FunctionPointer GetFunction(const std::string& name);
884
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
69 };
cd8a69aa4093 creation of branch plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
70 }