1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/************************************************************************
*
* Copyright (C) 2009-2025 IRCAD France
* Copyright (C) 2012-2020 IHU Strasbourg
*
* This file is part of Sight.
*
* Sight is free software: you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Sight is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with Sight. If not, see <https://www.gnu.org/licenses/>.
*
***********************************************************************/
#pragma once
#include <sight/core/config.hpp>
#include "core/runtime/extension.hpp"
#include "core/runtime/module.hpp"
#include <core/base.hpp>
#include <filesystem>
#include <iterator>
#include <memory>
#include <string>
namespace sight::core::runtime
{
class module;
/**
* @brief Initializes Sight runtime and discovers default modules.
*/
SIGHT_CORE_API void init();
/**
* @brief Shutdown Sight runtime, which means unload all loaded modules.
*/
SIGHT_CORE_API void shutdown();
/**
* @brief Loads all modules that can be found in the specified directory.
*
* @param _directory a path to the directory to explore for modules
*/
SIGHT_CORE_API void add_modules(const std::filesystem::path& _directory);
/**
* @brief Retrieves the module with the given identifier and version
*
* @param _identifier a string containing a module identifier
*
* @return a shared pointer to the found module, or empty when none
*/
SIGHT_CORE_API std::shared_ptr<module> find_module(const std::string& _identifier);
/**
* @brief Retrieves all modules
*
* @return a set of all modules
*/
SIGHT_CORE_API std::set<std::shared_ptr<module> > modules();
/**
* @brief Load a module.
*
* @param _identifier a string containing a module identifier
*
* @return a shared pointer to the found module, or empty when it is not found
*/
SIGHT_CORE_API std::shared_ptr<module> load_module(const std::string& _identifier);
/**
* @brief Starts the module specified by the given identifier.
*
* @param _identifier a string containing a module identifier
*/
SIGHT_CORE_API void start_module(const std::string& _identifier);
/**
* @brief Unload a module.
*
* @param _identifier a string containing a module identifier
*
* @return a shared pointer to the found module, or empty when it is not found
*/
SIGHT_CORE_API void unload_module(const std::string& _identifier);
/**
* @brief Load a library.
*
* @param _identifier a string containing a module identifier
*
* @return success
*/
SIGHT_CORE_API bool load_library(const std::string& _identifier);
/**
* @brief Retrieve the extension having the specified identifier.
*
* @param _identifier a string containing an extension identifier
*
* @return a shared pointer to the found extension or null if none
*/
SIGHT_CORE_API std::shared_ptr<extension> find_extension(const std::string& _identifier);
/// Returns extensions extending the _extension_pt extension point
SIGHT_CORE_API std::vector<std::shared_ptr<core::runtime::extension> > get_all_extensions_for_point(
std::string _extension_pt
);
/// Utility function used to trim leading '::' in identifiers of modules, services, objects, extensions, etc...
SIGHT_CORE_API std::string filter_id(const std::string& _identifier);
/// Utility function used to validate an XML configuration against a XSD schema
SIGHT_CORE_API bool validate(const config_t& _config, const std::filesystem::path& _schema);
} // namespace sight::core::runtime
|
