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
|
/************************************************************************
*
* Copyright (C) 2009-2024 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/module_element.hpp"
#include "core/runtime/types.hpp"
#include <boost/noncopyable.hpp>
#include <string>
namespace sight::core::runtime
{
class module;
/**
* @brief Defines the extension class.
*/
class SIGHT_CORE_CLASS_API extension : public module_element,
public boost::noncopyable
{
public:
/**
* @brief Constructor.
*
* @param[in] _module a pointer to the module the extension is attached to
* @param[in] _id a string containing the extension identifier
* @param[in] _point a string containing the extension point identifier
*
* @todo test parameters validity
*/
extension(
std::shared_ptr<module> _module,
const std::string& _id,
const std::string& _point
);
/**
* @brief Retrieves the extension identifier.
*
* @return a string containing the extension identifier (may be empty)
*/
[[nodiscard]] SIGHT_CORE_API const std::string& identifier() const;
/**
* @brief Retrieves the extension point identifier.
*
* @return a string containing the extension point identifier
*/
[[nodiscard]] SIGHT_CORE_API const std::string& point() const;
/**
* @brief Retrieves the extension point configuration.
*
* @return a string containing the extension point configuration
*/
[[nodiscard]] SIGHT_CORE_API virtual const config_t& get_config() const = 0;
private:
/// A string containing the extension identifier
const std::string m_id;
/// A string containing the extension point identifier the extension will be connected to
const std::string m_point;
/// The configuration of the extension
config_t m_config;
};
} // namespace sight::core::runtime
|
