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
|
/*
* Copyright (C) 2017 Open Source Robotics Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef IGNITION_PLUGIN_INFO_HH_
#define IGNITION_PLUGIN_INFO_HH_
#include <functional>
#include <memory>
#include <set>
#include <string>
#include <unordered_map>
#include <ignition/utilities/SuppressWarning.hh>
#include <ignition/plugin/Export.hh>
namespace ignition
{
namespace plugin
{
/// \brief sentinel value to check if a plugin was built with the same
/// version of the Info struct
//
/// This must be incremented when the Info struct changes
const int INFO_API_VERSION = 1;
// We use an inline namespace to assist in forward-compatibility. Eventually
// we may want to support a version-2 of the Info API, in which case
// we will remove the "inline" declaration here, and create a new inline
// namespace called "v2". This original Info object will continue to
// be accessible for backwards compatibility, and even its symbol name in
// the ABI should remain the same.
inline namespace v1
{
/// \brief Holds info required to construct a plugin
struct IGNITION_PLUGIN_VISIBLE Info
{
/// \brief Clear out all information contained in this Info object
void Clear();
/// \brief The name of the plugin
IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
std::string name;
IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
/// \brief Alternative names that may be used to instantiate the plugin
IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
std::set<std::string> aliases;
IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
/// \brief The keys are the names of the types of interfaces that this
/// plugin provides. The values are functions that convert a void
/// pointer (which actually points to the plugin instance) to another
/// void pointer (which actually points to the location of the interface
/// within the plugin instance).
IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
using InterfaceCastingMap =
std::unordered_map< std::string, std::function<void*(void*)> >;
InterfaceCastingMap interfaces;
IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
/// \brief This is a set containing the demangled versions of the names
/// of the interfaces provided by this plugin. This gets filled in by
/// the Loader after receiving the Info. It is only used by
/// the user-facing API. Internally, when looking up Interfaces, the
/// mangled `interfaces` map will still be used.
IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
std::set<std::string> demangledInterfaces;
IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
/// \brief A method that instantiates a new instance of a plugin
IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
std::function<void*()> factory;
IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
/// \brief A method that safely deletes an instance of the plugin
IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING
std::function<void(void*)> deleter;
IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING
};
}
/// This typedef is used simultaneously by detail/Register.hh and Loader.cc,
/// so we store it in a location that is visible to both of them.
using InfoMap = std::unordered_map<std::string, Info>;
using ConstInfoPtr = std::shared_ptr<const Info>;
}
}
#endif
|
